/*
** $Id: lgc.h,v 2.91.1.1 2017/04/19 17:39:34 roberto Exp $
** Garbage Collector
** See Copyright Notice in lua.h
*/

#ifndef lgc_h
#define lgc_h


#include "lobject.h"
#include "lstate.h"

/*
** Collectable objects may have one of three colors: white, which
** means the object is not marked; gray, which means the
** object is marked, but its references may be not marked; and
** black, which means that the object and all its references are marked.
** The main invariant of the garbage collector, while marking objects,
** is that a black object can never point to a white one. Moreover,
** any gray object must be in a "gray list" (gray, grayagain, weak,
** allweak, ephemeron) so that it can be visited again before finishing
** the collection cycle. These lists have no meaning when the invariant
** is not being enforced (e.g., sweep phase).
*/



/* how much to allocate before next GC step */
#if !defined(GCSTEPSIZE)
/* ~100 small strings */
#define GCSTEPSIZE  (cast_int(100 * sizeof(TString)))
#endif


/*
** Possible states of the Garbage Collector
*/
// GC 状态宏定义：表示垃圾回收过程中的不同阶段
#define GCSpropagate  0   // 标记传播阶段：遍历灰色对象链表，逐步将对象从灰色标记为黑色，并扫描其引用的子对象
#define GCSatomic     1   // 原子标记阶段：完成最终不可中断的标记操作，处理弱表、析构对象等，并切换当前白色（用于解决新对象误删问题）
#define GCSswpallgc   2   // 清扫常规对象阶段：遍历全局对象链表（`allgc`），释放未被标记（白色）的普通对象（如 Table、Closure 等）
#define GCSswpfinobj  3   // 清扫带析构器的对象阶段：释放未被标记（白色）且拥有析构器（`__gc`）的对象（如 Userdata）
#define GCSswptobefnz 4   // 清扫待析构对象阶段：处理已被标记需析构但尚未执行析构的对象链表（`tobefnz`），释放其内存
#define GCSswpend     5   // 清扫结束阶段：完成所有清扫操作，准备进入下一周期或暂停
#define GCScallfin    6   // 调用析构器阶段：执行待析构对象（如 Userdata）的 `__gc` 元方法
#define GCSpause      7   // 暂停或初始阶段：GC 未运行或刚启动，等待触发标记；若为新周期，则初始化根节点（如主线程、注册表）并进入 `GCSpropagate`


#define issweepphase(g)  \
  (GCSswpallgc <= (g)->gcstate && (g)->gcstate <= GCSswpend)


/*
** macro to tell when main invariant (white objects cannot point to black
** ones) must be kept. During a collection, the sweep
** phase may break the invariant, as objects turned white may point to
** still-black objects. The invariant is restored when sweep ends and
** all objects are white again.
 * 用于判断何时必须保持主要不变性（白色对象不能指向黑色对象）的宏。
 * 在收集过程中，清除阶段可能会破坏这一不变性，因为变为白色的对象可能会指向仍然为黑色的对象。
 * 当清除结束且所有对象再次变为白色时，不变性即恢复。
*/

#define keepinvariant(g)  ((g)->gcstate <= GCSatomic)


/*
** some useful bit tricks
*/
#define resetbits(x, m)    ((x) &= cast(lu_byte, ~(m)))
#define setbits(x, m)    ((x) |= (m))
#define testbits(x, m)    ((x) & (m))
#define bitmask(b)    (1<<(b))
#define bit2mask(b1, b2)    (bitmask(b1) | bitmask(b2))
#define l_setbit(x, b)    setbits(x, bitmask(b))
#define resetbit(x, b)    resetbits(x, bitmask(b))
#define testbit(x, b)    testbits(x, bitmask(b))


/* Layout for bit use in 'marked' field: */
#define WHITE0BIT  0  /* object is white (type 0) */
#define WHITE1BIT  1  /* object is white (type 1) */
#define BLACKBIT  2  /* object is black */
#define FINALIZEDBIT  3  /* object has been marked for finalization */
/* bit 7 is currently used by tests (luaL_checkmemory) */

/**
 * @brief 定义白色位的掩码，用于快速检查或设置白色相关的标志位。
 * 该宏通过组合 WHITE0BIT 和 WHITE1BIT 生成一个掩码，方便位操作。
 */
#define WHITEBITS bit2mask(WHITE0BIT, WHITE1BIT)

#define iswhite(x)      testbits((x)->marked, WHITEBITS)
#define isblack(x)      testbit((x)->marked, BLACKBIT)
#define isgray(x)  /* neither white nor black */  \
  (!testbits((x)->marked, WHITEBITS | bitmask(BLACKBIT)))

#define tofinalize(x)  testbit((x)->marked, FINALIZEDBIT)

#define otherwhite(g) ((g)->currentwhite ^ WHITEBITS)
/**
 * @brief 检查给定的掩码(m)是否在对象(ow)中标记为"dead"状态。
 *
 * @param ow 对象的状态位，通常是一个位掩码。
 * @param m 需要检查的掩码位。
 * @return 如果掩码(m)在对象(ow)中标记为"dead"状态，则返回true；否则返回false。
 *
 * @note 此宏通过位运算实现，具体逻辑为：将掩码(m)与WHITEBITS异或后，再与对象(ow)的位掩码进行与操作，结果为0则表示"dead"状态。
 */
#define isdeadm(ow, m) (!(((m) ^ WHITEBITS) & (ow)))
#define isdead(g, v) isdeadm(otherwhite(g), (v)->marked)

#define changewhite(x)  ((x)->marked ^= WHITEBITS)
#define gray2black(x) l_setbit((x)->marked, BLACKBIT)

/**
 * @brief 获取当前垃圾回收器的白色标记值。
 *
 * @param g 指向全局状态（global_State）的指针。
 * @return 返回当前白色标记的字节值（lu_byte类型），仅保留WHITEBITS定义的位。
 *
 * @note 此宏用于垃圾回收器内部，标记对象是否为当前回收周期的“白色”对象。
 */
#define luaC_white(g) cast(lu_byte, (g)->currentwhite &WHITEBITS)

/**
 * 在 GC 债务（GCdebt）变为正数时执行一步垃圾回收。
 * 参数 'pre' 和 'pos' 允许在需要时进行一些调整。
 * 宏 'condchangemem' 仅用于强制测试（每次机会都触发完整的 GC 周期）。
 *
 * @param L Lua 状态机指针。
 * @param pre 在 GC 步骤之前执行的代码块。
 * @param pos 在 GC 步骤之后执行的代码块。
 *
 * @note 此宏通常用于在内存压力较大时触发增量垃圾回收。
 */
/*
** Does one step of collection when debt becomes positive. 'pre'/'pos'
** allows some adjustments to be done only when needed. macro
** 'condchangemem' is used only for heavy tests (forcing a full
** GC cycle on every opportunity)
*/
#define luaC_condGC(L, pre, pos) \
  { if (G(L)->GCdebt > 0) { pre; luaC_step(L); pos;}; \
    condchangemem(L,pre,pos); }

/**
 * 检查并触发垃圾回收（GC）的条件宏。
 * 通常，'pre'和'pos'参数为空，仅在特定条件下执行GC操作。
 * 主要用于在Lua运行时中控制垃圾回收的触发时机。
 */
/* more often than not, 'pre'/'pos' are empty */
#define luaC_checkGC(L)    luaC_condGC(L,(void)0,(void)0)


/**
 * @brief 执行内存屏障操作，确保垃圾回收器正确处理对象引用关系。
 *
 * 该宏用于在垃圾回收过程中，确保黑色对象（已标记为存活）对白色对象（待回收）的引用被正确处理。
 * 如果满足以下条件，则调用 `luaC_barrier_` 执行屏障操作：
 * 1. `v` 是可回收对象（iscollectable(v)）。
 * 2. `p` 是黑色对象（isblack(p)）。
 * 3. `v` 的垃圾回收值是白色对象（iswhite(gcvalue(v))）。
 *
 * 如果不满足条件，则无操作（cast_void(0)）。
 *
 * @param L Lua 状态机指针。
 * @param p 父对象（黑色对象）。
 * @param v 子对象（可能为白色对象）。
 */
#define luaC_barrier(L, p, v) (  \
  (iscollectable(v) && isblack(p) && iswhite(gcvalue(v))) ?  \
  luaC_barrier_(L,obj2gco(p),gcvalue(v)) : cast_void(0))

/**
 * @brief 执行后向屏障操作，用于垃圾回收中的写屏障。
 *
 * 该宏用于在垃圾回收过程中处理后向屏障（backward barrier），确保黑色对象（已标记为存活的对象）
 * 不会引用白色对象（未被标记的对象），从而避免错误的垃圾回收。
 *
 * @param L Lua状态机指针。
 * @param p 黑色对象（已标记为存活的对象）。
 * @param v 被引用的值（可能是白色对象）。
 *
 * @note 如果满足以下条件，则调用 `luaC_barrierback_` 函数：
 *       1. `v` 是可回收对象（iscollectable(v)）。
 *       2. `p` 是黑色对象（isblack(p)）。
 *       3. `v` 是白色对象（iswhite(gcvalue(v))）。
 *       否则，不执行任何操作（cast_void(0)）。
 */
#define luaC_barrierback(L, p, v) (  \
  (iscollectable(v) && isblack(p) && iswhite(gcvalue(v))) ? \
  luaC_barrierback_(L,p) : cast_void(0))

// luaC_objbarrier 宏的作用是在适当的时候调用写屏障函数 luaC_barrier_，以确保垃圾收集器可以跟踪黑色对象到白色对象的引用。
#define luaC_objbarrier(L, p, o) (  \
  (isblack(p) && iswhite(o)) ? \
  luaC_barrier_(L,obj2gco(p),obj2gco(o)) : cast_void(0))

/**
 * @brief 执行上值（upvalue）的屏障操作，确保垃圾回收器正确处理上值。
 *
 * 该宏用于在上值可能被回收时触发屏障操作。仅当上值是可收集对象且未被打开时，
 * 才会调用实际的屏障函数 `luaC_upvalbarrier_`，否则不执行任何操作。
 *
 * @param L Lua 状态机指针。
 * @param uv 上值指针。
 */
#define luaC_upvalbarrier(L, uv) ( \
  (iscollectable((uv)->v) && !upisopen(uv)) ? \
         luaC_upvalbarrier_(L,uv) : cast_void(0))

LUAI_FUNC void luaC_fix(lua_State *L, GCObject *o);

LUAI_FUNC void luaC_freeallobjects(lua_State *L);

LUAI_FUNC void luaC_step(lua_State *L);

LUAI_FUNC void luaC_runtilstate(lua_State *L, int statesmask);

LUAI_FUNC void luaC_fullgc(lua_State *L, int isemergency);

LUAI_FUNC GCObject *luaC_newobj(lua_State *L, int tt, size_t sz);

LUAI_FUNC void luaC_barrier_(lua_State *L, GCObject *o, GCObject *v);

LUAI_FUNC void luaC_barrierback_(lua_State *L, Table *o);

LUAI_FUNC void luaC_upvalbarrier_(lua_State *L, UpVal *uv);

LUAI_FUNC void luaC_checkfinalizer(lua_State *L, GCObject *o, Table *mt);

LUAI_FUNC void luaC_upvdeccount(lua_State *L, UpVal *uv);


#endif
